3 use Wikimedia\TestingAccessWrapper
;
5 class ResourceLoaderTest
extends ResourceLoaderTestCase
{
7 protected function setUp() {
10 $this->setMwGlobals( [
11 'wgShowExceptionDetails' => true,
16 * Ensure the ResourceLoaderRegisterModules hook is called.
18 * @covers ResourceLoader::__construct
20 public function testConstructRegistrationHook() {
21 $resourceLoaderRegisterModulesHook = false;
23 $this->setMwGlobals( 'wgHooks', [
24 'ResourceLoaderRegisterModules' => [
25 function ( &$resourceLoader ) use ( &$resourceLoaderRegisterModulesHook ) {
26 $resourceLoaderRegisterModulesHook = true;
31 $unused = new ResourceLoader();
33 $resourceLoaderRegisterModulesHook,
34 'Hook ResourceLoaderRegisterModules called'
39 * @covers ResourceLoader::register
40 * @covers ResourceLoader::getModule
42 public function testRegisterValidObject() {
43 $module = new ResourceLoaderTestModule();
44 $resourceLoader = new EmptyResourceLoader();
45 $resourceLoader->register( 'test', $module );
46 $this->assertEquals( $module, $resourceLoader->getModule( 'test' ) );
50 * @covers ResourceLoader::register
51 * @covers ResourceLoader::getModule
53 public function testRegisterValidArray() {
54 $module = new ResourceLoaderTestModule();
55 $resourceLoader = new EmptyResourceLoader();
56 // Covers case of register() setting $rl->moduleInfos,
57 // but $rl->modules lazy-populated by getModule()
58 $resourceLoader->register( 'test', [ 'object' => $module ] );
59 $this->assertEquals( $module, $resourceLoader->getModule( 'test' ) );
63 * @covers ResourceLoader::register
65 public function testRegisterEmptyString() {
66 $module = new ResourceLoaderTestModule();
67 $resourceLoader = new EmptyResourceLoader();
68 $resourceLoader->register( '', $module );
69 $this->assertEquals( $module, $resourceLoader->getModule( '' ) );
73 * @covers ResourceLoader::register
75 public function testRegisterInvalidName() {
76 $resourceLoader = new EmptyResourceLoader();
77 $this->setExpectedException( MWException
::class, "name 'test!invalid' is invalid" );
78 $resourceLoader->register( 'test!invalid', new ResourceLoaderTestModule() );
82 * @covers ResourceLoader::register
84 public function testRegisterInvalidType() {
85 $resourceLoader = new EmptyResourceLoader();
86 $this->setExpectedException( MWException
::class, 'ResourceLoader module info type error' );
87 $resourceLoader->register( 'test', new stdClass() );
91 * @covers ResourceLoader::register
93 public function testRegisterDuplicate() {
94 $logger = $this->getMockBuilder( Psr\Log\LoggerInterface
::class )->getMock();
95 $logger->expects( $this->once() )
96 ->method( 'warning' );
97 $resourceLoader = new EmptyResourceLoader( null, $logger );
99 $module1 = new ResourceLoaderTestModule();
100 $module2 = new ResourceLoaderTestModule();
101 $resourceLoader->register( 'test', $module1 );
102 $resourceLoader->register( 'test', $module2 );
103 $this->assertSame( $module2, $resourceLoader->getModule( 'test' ) );
107 * @covers ResourceLoader::getModuleNames
109 public function testGetModuleNames() {
110 // Use an empty one so that core and extension modules don't get in.
111 $resourceLoader = new EmptyResourceLoader();
112 $resourceLoader->register( 'test.foo', new ResourceLoaderTestModule() );
113 $resourceLoader->register( 'test.bar', new ResourceLoaderTestModule() );
115 [ 'test.foo', 'test.bar' ],
116 $resourceLoader->getModuleNames()
120 public function provideTestIsFileModule() {
121 $fileModuleObj = $this->getMockBuilder( ResourceLoaderFileModule
::class )
122 ->disableOriginalConstructor()
126 new ResourceLoaderTestModule()
128 'FileModule object' => [ false,
131 'simple empty' => [ true,
134 'simple scripts' => [ true,
135 [ 'scripts' => 'example.js' ]
137 'simple scripts, raw and targets' => [ true, [
138 'scripts' => [ 'a.js', 'b.js' ],
140 'targets' => [ 'desktop', 'mobile' ],
142 'FileModule' => [ true,
143 [ 'class' => ResourceLoaderFileModule
::class, 'scripts' => 'example.js' ]
145 'TestModule' => [ false,
146 [ 'class' => ResourceLoaderTestModule
::class, 'scripts' => 'example.js' ]
148 'SkinModule (FileModule subclass)' => [ true,
149 [ 'class' => ResourceLoaderSkinModule
::class, 'scripts' => 'example.js' ]
151 'WikiModule' => [ false, [
152 'class' => ResourceLoaderWikiModule
::class,
153 'scripts' => [ 'MediaWiki:Example.js' ],
159 * @dataProvider provideTestIsFileModule
160 * @covers ResourceLoader::isFileModule
162 public function testIsFileModule( $expected, $module ) {
163 $rl = TestingAccessWrapper
::newFromObject( new EmptyResourceLoader() );
164 $rl->register( 'test', $module );
165 $this->assertSame( $expected, $rl->isFileModule( 'test' ) );
169 * @covers ResourceLoader::isFileModule
171 public function testIsFileModuleUnknown() {
172 $rl = TestingAccessWrapper
::newFromObject( new EmptyResourceLoader() );
173 $this->assertSame( false, $rl->isFileModule( 'unknown' ) );
177 * @covers ResourceLoader::isModuleRegistered
179 public function testIsModuleRegistered() {
180 $rl = new EmptyResourceLoader();
181 $rl->register( 'test', new ResourceLoaderTestModule() );
182 $this->assertTrue( $rl->isModuleRegistered( 'test' ) );
183 $this->assertFalse( $rl->isModuleRegistered( 'test.unknown' ) );
187 * @covers ResourceLoader::getModule
189 public function testGetModuleUnknown() {
190 $rl = new EmptyResourceLoader();
191 $this->assertSame( null, $rl->getModule( 'test' ) );
195 * @covers ResourceLoader::getModule
197 public function testGetModuleClass() {
198 $rl = new EmptyResourceLoader();
199 $rl->register( 'test', [ 'class' => ResourceLoaderTestModule
::class ] );
200 $this->assertInstanceOf(
201 ResourceLoaderTestModule
::class,
202 $rl->getModule( 'test' )
207 * @covers ResourceLoader::getModule
209 public function testGetModuleFactory() {
210 $factory = function ( array $info ) {
211 $this->assertArrayHasKey( 'kitten', $info );
212 return new ResourceLoaderTestModule( $info );
215 $rl = new EmptyResourceLoader();
216 $rl->register( 'test', [ 'factory' => $factory, 'kitten' => 'little ball of fur' ] );
217 $this->assertInstanceOf(
218 ResourceLoaderTestModule
::class,
219 $rl->getModule( 'test' )
224 * @covers ResourceLoader::getModule
226 public function testGetModuleClassDefault() {
227 $rl = new EmptyResourceLoader();
228 $rl->register( 'test', [] );
229 $this->assertInstanceOf(
230 ResourceLoaderFileModule
::class,
231 $rl->getModule( 'test' ),
232 'Array-style module registrations default to FileModule'
237 * @covers ResourceLoader::getLessCompiler
239 public function testLessImportDirs() {
240 $rl = new EmptyResourceLoader();
241 $lc = $rl->getLessCompiler( [ 'foo' => '2px', 'Foo' => '#eeeeee' ] );
242 $basePath = dirname( dirname( __DIR__
) ) . '/data/less';
243 $lc->SetImportDirs( [
244 "$basePath/common" => '',
246 $css = $lc->parseFile( "$basePath/module/use-import-dir.less" )->getCss();
247 $this->assertStringEqualsFile( "$basePath/module/styles.css", $css );
250 public static function providePackedModules() {
253 'Example from makePackedModulesString doc comment',
254 [ 'foo.bar', 'foo.baz', 'bar.baz', 'bar.quux' ],
255 'foo.bar,baz|bar.baz,quux',
258 'Example from expandModuleNames doc comment',
259 [ 'jquery.foo', 'jquery.bar', 'jquery.ui.baz', 'jquery.ui.quux' ],
260 'jquery.foo,bar|jquery.ui.baz,quux',
263 'Regression fixed in r87497 (7fee86c38e) with dotless names',
264 [ 'foo', 'bar', 'baz' ],
268 'Prefixless modules after a prefixed module',
269 [ 'single.module', 'foobar', 'foobaz' ],
270 'single.module|foobar,foobaz',
274 [ 'foo', 'foo.baz', 'baz.quux', 'foo.bar' ],
275 'foo|foo.baz,bar|baz.quux',
276 [ 'foo', 'foo.baz', 'foo.bar', 'baz.quux' ],
282 * @dataProvider providePackedModules
283 * @covers ResourceLoader::makePackedModulesString
285 public function testMakePackedModulesString( $desc, $modules, $packed ) {
286 $this->assertEquals( $packed, ResourceLoader
::makePackedModulesString( $modules ), $desc );
290 * @dataProvider providePackedModules
291 * @covers ResourceLoaderContext::expandModuleNames
293 public function testExpandModuleNames( $desc, $modules, $packed, $unpacked = null ) {
295 $unpacked ?
: $modules,
296 ResourceLoaderContext
::expandModuleNames( $packed ),
301 public static function provideAddSource() {
303 [ 'foowiki', 'https://example.org/w/load.php', 'foowiki' ],
304 [ 'foowiki', [ 'loadScript' => 'https://example.org/w/load.php' ], 'foowiki' ],
307 'foowiki' => 'https://example.org/w/load.php',
308 'bazwiki' => 'https://example.com/w/load.php',
311 [ 'foowiki', 'bazwiki' ]
317 * @dataProvider provideAddSource
318 * @covers ResourceLoader::addSource
319 * @covers ResourceLoader::getSources
321 public function testAddSource( $name, $info, $expected ) {
322 $rl = new ResourceLoader
;
323 $rl->addSource( $name, $info );
324 if ( is_array( $expected ) ) {
325 foreach ( $expected as $source ) {
326 $this->assertArrayHasKey( $source, $rl->getSources() );
329 $this->assertArrayHasKey( $expected, $rl->getSources() );
334 * @covers ResourceLoader::addSource
336 public function testAddSourceDupe() {
337 $rl = new ResourceLoader
;
338 $this->setExpectedException(
339 MWException
::class, 'ResourceLoader duplicate source addition error'
341 $rl->addSource( 'foo', 'https://example.org/w/load.php' );
342 $rl->addSource( 'foo', 'https://example.com/w/load.php' );
346 * @covers ResourceLoader::addSource
348 public function testAddSourceInvalid() {
349 $rl = new ResourceLoader
;
350 $this->setExpectedException( MWException
::class, 'with no "loadScript" key' );
351 $rl->addSource( 'foo', [ 'x' => 'https://example.org/w/load.php' ] );
354 public static function provideLoaderImplement() {
357 'title' => 'Implement scripts, styles and messages',
359 'name' => 'test.example',
360 'scripts' => 'mw.example();',
361 'styles' => [ 'css' => [ '.mw-example {}' ] ],
362 'messages' => [ 'example' => '' ],
365 'expected' => 'mw.loader.implement( "test.example", function ( $, jQuery, require, module ) {
376 'title' => 'Implement scripts',
378 'name' => 'test.example',
379 'scripts' => 'mw.example();',
382 'expected' => 'mw.loader.implement( "test.example", function ( $, jQuery, require, module ) {
387 'title' => 'Implement styles',
389 'name' => 'test.example',
391 'styles' => [ 'css' => [ '.mw-example {}' ] ],
393 'expected' => 'mw.loader.implement( "test.example", [], {
400 'title' => 'Implement scripts and messages',
402 'name' => 'test.example',
403 'scripts' => 'mw.example();',
404 'messages' => [ 'example' => '' ],
406 'expected' => 'mw.loader.implement( "test.example", function ( $, jQuery, require, module ) {
413 'title' => 'Implement scripts and templates',
415 'name' => 'test.example',
416 'scripts' => 'mw.example();',
417 'templates' => [ 'example.html' => '' ],
419 'expected' => 'mw.loader.implement( "test.example", function ( $, jQuery, require, module ) {
426 'title' => 'Implement unwrapped user script',
429 'scripts' => 'mw.example( 1 );',
432 'expected' => 'mw.loader.implement( "user", "mw.example( 1 );" );',
435 'title' => 'Implement multi-file script',
437 'name' => 'test.multifile',
442 'content' => 'mw.example( 1 );',
446 'content' => [ 'n' => 2 ],
450 'content' => 'mw.example( 3 );'
453 'main' => 'three.js',
457 mw.loader.implement( "test.multifile", {
460 "one.js": function ( require, module ) {
466 "three.js": function ( require, module ) {
477 * @dataProvider provideLoaderImplement
478 * @covers ResourceLoader::makeLoaderImplementScript
479 * @covers ResourceLoader::trimArray
481 public function testMakeLoaderImplementScript( $case ) {
484 'styles' => [], 'templates' => [], 'messages' => new XmlJsCode( '{}' ), 'packageFiles' => [],
486 ResourceLoader
::clearCache();
487 $this->setMwGlobals( 'wgResourceLoaderDebug', true );
489 $rl = TestingAccessWrapper
::newFromClass( ResourceLoader
::class );
492 $rl->makeLoaderImplementScript(
494 ( $case['wrap'] && is_string( $case['scripts'] ) )
495 ?
new XmlJsCode( $case['scripts'] )
500 $case['packageFiles']
506 * @covers ResourceLoader::makeLoaderImplementScript
508 public function testMakeLoaderImplementScriptInvalid() {
509 $this->setExpectedException( MWException
::class, 'Invalid scripts error' );
510 $rl = TestingAccessWrapper
::newFromClass( ResourceLoader
::class );
511 $rl->makeLoaderImplementScript(
517 null // package files
522 * @covers ResourceLoader::makeLoaderRegisterScript
524 public function testMakeLoaderRegisterScript() {
526 'mw.loader.register( [
532 ResourceLoader
::makeLoaderRegisterScript( [
533 [ 'test.name', '1234567' ],
535 'Nested array parameter'
539 'mw.loader.register( [
568 ResourceLoader
::makeLoaderRegisterScript( [
569 [ 'test.foo', '100' , [], null, null ],
570 [ 'test.bar', '200', [ 'test.unknown' ], null ],
571 [ 'test.baz', '300', [ 'test.quux', 'test.foo' ], null ],
572 [ 'test.quux', '400', [], null, null, 'return true;' ],
574 'Compact dependency indexes'
579 * @covers ResourceLoader::makeLoaderSourcesScript
581 public function testMakeLoaderSourcesScript() {
583 'mw.loader.addSource( {
584 "local": "/w/load.php"
586 ResourceLoader
::makeLoaderSourcesScript( 'local', '/w/load.php' )
589 'mw.loader.addSource( {
590 "local": "/w/load.php"
592 ResourceLoader
::makeLoaderSourcesScript( [ 'local' => '/w/load.php' ] )
595 'mw.loader.addSource( {
596 "local": "/w/load.php",
597 "example": "https://example.org/w/load.php"
599 ResourceLoader
::makeLoaderSourcesScript( [
600 'local' => '/w/load.php',
601 'example' => 'https://example.org/w/load.php'
605 'mw.loader.addSource( [] );',
606 ResourceLoader
::makeLoaderSourcesScript( [] )
610 private static function fakeSources() {
613 'loadScript' => '//example.org/w/load.php',
614 'apiScript' => '//example.org/w/api.php',
617 'loadScript' => '//example.com/w/load.php',
618 'apiScript' => '//example.com/w/api.php',
624 * @covers ResourceLoader::getLoadScript
626 public function testGetLoadScript() {
627 $this->setMwGlobals( 'wgResourceLoaderSources', [] );
628 $rl = new ResourceLoader();
629 $sources = self
::fakeSources();
630 $rl->addSource( $sources );
631 foreach ( [ 'examplewiki', 'example2wiki' ] as $name ) {
632 $this->assertEquals( $rl->getLoadScript( $name ), $sources[$name]['loadScript'] );
636 $rl->getLoadScript( 'thiswasneverreigstered' );
637 $this->assertTrue( false, 'ResourceLoader::getLoadScript should have thrown an exception' );
638 } catch ( MWException
$e ) {
639 $this->assertTrue( true );
643 protected function getFailFerryMock( $getter = 'getScript' ) {
644 $mock = $this->getMockBuilder( ResourceLoaderTestModule
::class )
645 ->setMethods( [ $getter ] )
647 $mock->method( $getter )->will( $this->throwException(
648 new Exception( 'Ferry not found' )
653 protected function getSimpleModuleMock( $script = '' ) {
654 $mock = $this->getMockBuilder( ResourceLoaderTestModule
::class )
655 ->setMethods( [ 'getScript' ] )
657 $mock->method( 'getScript' )->willReturn( $script );
661 protected function getSimpleStyleModuleMock( $styles = '' ) {
662 $mock = $this->getMockBuilder( ResourceLoaderTestModule
::class )
663 ->setMethods( [ 'getStyles' ] )
665 $mock->method( 'getStyles' )->willReturn( [ '' => $styles ] );
670 * @covers ResourceLoader::getCombinedVersion
672 public function testGetCombinedVersion() {
673 $rl = $this->getMockBuilder( EmptyResourceLoader
::class )
674 // Disable log from outputErrorAndLog
675 ->setMethods( [ 'outputErrorAndLog' ] )->getMock();
677 'foo' => self
::getSimpleModuleMock(),
678 'ferry' => self
::getFailFerryMock(),
679 'bar' => self
::getSimpleModuleMock(),
681 $context = $this->getResourceLoaderContext( [], $rl );
685 $rl->getCombinedVersion( $context, [] ),
690 ResourceLoader
::makeHash( self
::BLANK_VERSION
),
691 $rl->getCombinedVersion( $context, [ 'foo' ] ),
695 // Verify that getCombinedVersion() does not throw when ferry fails.
696 // Instead it gracefully continues to combine the remaining modules.
698 ResourceLoader
::makeHash( self
::BLANK_VERSION
. self
::BLANK_VERSION
),
699 $rl->getCombinedVersion( $context, [ 'foo', 'ferry', 'bar' ] ),
700 'compute foo+ferry+bar (T152266)'
704 public static function provideMakeModuleResponseConcat() {
710 'expected' => "foo()\n" . 'mw.loader.state( {
713 'minified' => "foo()\n" . 'mw.loader.state({"foo":"ready"});',
714 'message' => 'Script without semi-colon',
721 'expected' => "foo()\nbar()\n" . 'mw.loader.state( {
725 'minified' => "foo()\nbar()\n" . 'mw.loader.state({"foo":"ready","bar":"ready"});',
726 'message' => 'Two scripts without semi-colon',
730 'foo' => "foo()\n// bar();"
732 'expected' => "foo()\n// bar();\n" . 'mw.loader.state( {
735 'minified' => "foo()\n" . 'mw.loader.state({"foo":"ready"});',
736 'message' => 'Script with semi-colon in comment (T162719)',
740 foreach ( $testcases as $i => $case ) {
747 $ret["#$i (minified)"] = [
758 * Verify how multiple scripts and mw.loader.state() calls are concatenated.
760 * @dataProvider provideMakeModuleResponseConcat
761 * @covers ResourceLoader::makeModuleResponse
763 public function testMakeModuleResponseConcat( $scripts, $expected, $debug, $message = null ) {
764 $rl = new EmptyResourceLoader();
765 $modules = array_map( function ( $script ) {
766 return self
::getSimpleModuleMock( $script );
768 $rl->register( $modules );
770 $this->setMwGlobals( 'wgResourceLoaderDebug', $debug );
771 $context = $this->getResourceLoaderContext(
773 'modules' => implode( '|', array_keys( $modules ) ),
779 $response = $rl->makeModuleResponse( $context, $modules );
780 $this->assertSame( [], $rl->getErrors(), 'Errors' );
781 $this->assertEquals( $expected, $response, $message ?
: 'Response' );
785 * @covers ResourceLoader::makeModuleResponse
787 public function testMakeModuleResponseEmpty() {
788 $rl = new EmptyResourceLoader();
789 $context = $this->getResourceLoaderContext(
790 [ 'modules' => '', 'only' => 'scripts' ],
794 $response = $rl->makeModuleResponse( $context, [] );
795 $this->assertSame( [], $rl->getErrors(), 'Errors' );
796 $this->assertRegExp( '/^\/\*.+no modules were requested.+\*\/$/ms', $response );
800 * Verify that when building module content in a load.php response,
801 * an exception from one module will not break script output from
804 * @covers ResourceLoader::makeModuleResponse
806 public function testMakeModuleResponseError() {
808 'foo' => self
::getSimpleModuleMock( 'foo();' ),
809 'ferry' => self
::getFailFerryMock(),
810 'bar' => self
::getSimpleModuleMock( 'bar();' ),
812 $rl = new EmptyResourceLoader();
813 $rl->register( $modules );
814 $context = $this->getResourceLoaderContext(
816 'modules' => 'foo|ferry|bar',
822 // Disable log from makeModuleResponse via outputErrorAndLog
823 $this->setLogger( 'exception', new Psr\Log\
NullLogger() );
825 $response = $rl->makeModuleResponse( $context, $modules );
826 $errors = $rl->getErrors();
828 $this->assertCount( 1, $errors );
829 $this->assertRegExp( '/Ferry not found/', $errors[0] );
831 "foo();\nbar();\n" . 'mw.loader.state( {
841 * Verify that exceptions in PHP for one module will not break others
842 * (stylesheet response).
844 * @covers ResourceLoader::makeModuleResponse
846 public function testMakeModuleResponseErrorCSS() {
848 'foo' => self
::getSimpleStyleModuleMock( '.foo{}' ),
849 'ferry' => self
::getFailFerryMock( 'getStyles' ),
850 'bar' => self
::getSimpleStyleModuleMock( '.bar{}' ),
852 $rl = new EmptyResourceLoader();
853 $rl->register( $modules );
854 $context = $this->getResourceLoaderContext(
856 'modules' => 'foo|ferry|bar',
863 // Disable log from makeModuleResponse via outputErrorAndLog
864 $this->setLogger( 'exception', new Psr\Log\
NullLogger() );
866 $response = $rl->makeModuleResponse( $context, $modules );
867 $errors = $rl->getErrors();
869 $this->assertCount( 2, $errors );
870 $this->assertRegExp( '/Ferry not found/', $errors[0] );
871 $this->assertRegExp( '/Problem.+"ferry":\s*"error"/ms', $errors[1] );
879 * Verify that when building the startup module response,
880 * an exception from one module class will not break the entire
881 * startup module response. See T152266.
883 * @covers ResourceLoader::makeModuleResponse
885 public function testMakeModuleResponseStartupError() {
886 $rl = new EmptyResourceLoader();
888 'foo' => self
::getSimpleModuleMock( 'foo();' ),
889 'ferry' => self
::getFailFerryMock(),
890 'bar' => self
::getSimpleModuleMock( 'bar();' ),
891 'startup' => [ 'class' => ResourceLoaderStartUpModule
::class ],
893 $context = $this->getResourceLoaderContext(
895 'modules' => 'startup',
902 [ 'foo', 'ferry', 'bar', 'startup' ],
903 $rl->getModuleNames(),
907 // Disable log from makeModuleResponse via outputErrorAndLog
908 $this->setLogger( 'exception', new Psr\Log\
NullLogger() );
910 $modules = [ 'startup' => $rl->getModule( 'startup' ) ];
911 $response = $rl->makeModuleResponse( $context, $modules );
912 $errors = $rl->getErrors();
914 $this->assertRegExp( '/Ferry not found/', $errors[0] );
915 $this->assertCount( 1, $errors );
917 '/isCompatible.*window\.RLQ/s',
919 'startup response undisrupted (T152266)'
922 '/register\([^)]+"ferry",\s*""/s',
924 'startup response registers broken module'
927 '/state\([^)]+"ferry":\s*"error"/s',
929 'startup response sets state to error'
934 * Integration test for modules sending extra HTTP response headers.
936 * @covers ResourceLoaderModule::getHeaders
937 * @covers ResourceLoaderModule::buildContent
938 * @covers ResourceLoader::makeModuleResponse
940 public function testMakeModuleResponseExtraHeaders() {
941 $module = $this->getMockBuilder( ResourceLoaderTestModule
::class )
942 ->setMethods( [ 'getPreloadLinks' ] )->getMock();
943 $module->method( 'getPreloadLinks' )->willReturn( [
944 'https://example.org/script.js' => [ 'as' => 'script' ],
947 $rl = new EmptyResourceLoader();
951 $context = $this->getResourceLoaderContext(
952 [ 'modules' => 'foo', 'only' => 'scripts' ],
956 $modules = [ 'foo' => $rl->getModule( 'foo' ) ];
957 $response = $rl->makeModuleResponse( $context, $modules );
958 $extraHeaders = TestingAccessWrapper
::newFromObject( $rl )->extraHeaders
;
962 'Link: <https://example.org/script.js>;rel=preload;as=script'
970 * @covers ResourceLoaderModule::getHeaders
971 * @covers ResourceLoaderModule::buildContent
972 * @covers ResourceLoader::makeModuleResponse
974 public function testMakeModuleResponseExtraHeadersMulti() {
975 $foo = $this->getMockBuilder( ResourceLoaderTestModule
::class )
976 ->setMethods( [ 'getPreloadLinks' ] )->getMock();
977 $foo->method( 'getPreloadLinks' )->willReturn( [
978 'https://example.org/script.js' => [ 'as' => 'script' ],
981 $bar = $this->getMockBuilder( ResourceLoaderTestModule
::class )
982 ->setMethods( [ 'getPreloadLinks' ] )->getMock();
983 $bar->method( 'getPreloadLinks' )->willReturn( [
984 '/example.png' => [ 'as' => 'image' ],
985 '/example.jpg' => [ 'as' => 'image' ],
988 $rl = new EmptyResourceLoader();
989 $rl->register( [ 'foo' => $foo, 'bar' => $bar ] );
990 $context = $this->getResourceLoaderContext(
991 [ 'modules' => 'foo|bar', 'only' => 'scripts' ],
995 $modules = [ 'foo' => $rl->getModule( 'foo' ), 'bar' => $rl->getModule( 'bar' ) ];
996 $response = $rl->makeModuleResponse( $context, $modules );
997 $extraHeaders = TestingAccessWrapper
::newFromObject( $rl )->extraHeaders
;
1000 'Link: <https://example.org/script.js>;rel=preload;as=script',
1001 'Link: </example.png>;rel=preload;as=image,</example.jpg>;rel=preload;as=image'
1009 * @covers ResourceLoader::respond
1011 public function testRespondEmpty() {
1012 $rl = $this->getMockBuilder( EmptyResourceLoader
::class )
1014 'tryRespondNotModified',
1015 'sendResponseHeaders',
1016 'measureResponseTime',
1019 $context = $this->getResourceLoaderContext( [ 'modules' => '' ], $rl );
1021 $rl->expects( $this->once() )->method( 'measureResponseTime' );
1022 $this->expectOutputRegex( '/no modules were requested/' );
1024 $rl->respond( $context );
1028 * @covers ResourceLoader::respond
1030 public function testRespondSimple() {
1031 $module = new ResourceLoaderTestModule( [ 'script' => 'foo();' ] );
1032 $rl = $this->getMockBuilder( EmptyResourceLoader
::class )
1034 'measureResponseTime',
1035 'tryRespondNotModified',
1036 'sendResponseHeaders',
1037 'makeModuleResponse',
1040 $rl->register( 'test', $module );
1041 $context = $this->getResourceLoaderContext(
1042 [ 'modules' => 'test', 'only' => null ],
1046 $rl->expects( $this->once() )->method( 'makeModuleResponse' )
1047 ->with( $context, [ 'test' => $module ] )
1048 ->willReturn( 'implement_foo;' );
1049 $this->expectOutputRegex( '/^implement_foo;/' );
1051 $rl->respond( $context );
1055 * @covers ResourceLoader::respond
1057 public function testRespondInternalFailures() {
1058 $module = new ResourceLoaderTestModule( [ 'script' => 'foo();' ] );
1059 $rl = $this->getMockBuilder( EmptyResourceLoader
::class )
1061 'measureResponseTime',
1062 'preloadModuleInfo',
1063 'getCombinedVersion',
1064 'tryRespondNotModified',
1065 'makeModuleResponse',
1066 'sendResponseHeaders',
1069 $rl->register( 'test', $module );
1070 $context = $this->getResourceLoaderContext( [ 'modules' => 'test' ], $rl );
1071 // Disable logging from outputErrorAndLog
1072 $this->setLogger( 'exception', new Psr\Log\
NullLogger() );
1074 $rl->expects( $this->once() )->method( 'preloadModuleInfo' )
1075 ->willThrowException( new Exception( 'Preload error' ) );
1076 $rl->expects( $this->once() )->method( 'getCombinedVersion' )
1077 ->willThrowException( new Exception( 'Version error' ) );
1078 $rl->expects( $this->once() )->method( 'makeModuleResponse' )
1079 ->with( $context, [ 'test' => $module ] )
1080 ->willReturn( 'foo;' );
1081 // Internal errors should be caught and logged without affecting module output
1082 $this->expectOutputRegex( '/^\/\*.+Preload error.+Version error.+\*\/.*foo;/ms' );
1084 $rl->respond( $context );
1088 * @covers ResourceLoader::measureResponseTime
1090 public function testMeasureResponseTime() {
1091 $stats = $this->getMockBuilder( NullStatsdDataFactory
::class )
1092 ->setMethods( [ 'timing' ] )->getMock();
1093 $this->setService( 'StatsdDataFactory', $stats );
1095 $stats->expects( $this->once() )->method( 'timing' )
1096 ->with( 'resourceloader.responseTime', $this->anything() );
1098 $timing = new Timing();
1099 $timing->mark( 'requestShutdown' );
1100 $rl = TestingAccessWrapper
::newFromObject( new EmptyResourceLoader
);
1101 $rl->measureResponseTime( $timing );
1102 DeferredUpdates
::doUpdates();